Skip to content

docs(installation): clarify download/staging copy + collapse init script render#31

Merged
mjohns-databricks merged 1 commit into
mainfrom
beta/0.3.0
May 20, 2026
Merged

docs(installation): clarify download/staging copy + collapse init script render#31
mjohns-databricks merged 1 commit into
mainfrom
beta/0.3.0

Conversation

@mjohns-databricks
Copy link
Copy Markdown
Collaborator

Summary

Doc-only PR. Two kinds of changes to docs/docs/installation.mdx:

Clarifications (three small wording tweaks):

  • "attaches three files" → "attaches three files (among others)" — the release page has more than just those three, the original phrasing implied otherwise.
  • "not uploaded to the bundle Volume" → "not included in the bundle (from above)" — reads more naturally after the preceding section introduced the bundle.
  • Step 3.1: name VOL_DIR as a candidate staging location for the init script itself, so readers don't have to invent a path.

Render improvement — the inline <CodeFromTest code={initScript} … /> was rendering all ~400 lines of geobrix-gdal-init.sh, dominating the install page for readers scrolling past it. Replaced with a 10-line preview + native HTML <details> disclosure containing the full script:

Preview of the first 10 lines — expand below for the full script (~400 lines).

<CodeFromTest
  code={initScript.split('\n').slice(0, 10).join('\n') + '\n# ... (expand the disclosure below for the full script)'}
  
/>

<details>
  <summary>Show the full init script</summary>

<CodeFromTest code={initScript}  />

</details>

The MDX expression slicing happens at render time against the raw-loader string, so the preview stays in sync with the script automatically — no manual sync needed.

Test plan

  • gbx:docs:dev — verify the preview renders as the first 10 lines and the disclosure is collapsed by default + expands cleanly to the full script.
  • Confirm the link to [scripts/geobrix-gdal-init.sh](https://github.com/databrickslabs/geobrix/blob/main/scripts/geobrix-gdal-init.sh) in step 3 still resolves (it's unchanged but worth a glance).
  • Confirm responsive behavior on a narrow viewport — <details> is native HTML so Docusaurus's default theme handles it, but worth one mobile-width sanity check.

This pull request and its description were written by Isaac.

Three small wording clarifications + a render improvement so the
~400-line init script doesn't dominate the install page.

Clarifications (mjohns):
- "attaches three files" → "attaches three files (among others)" — set
  expectation that the release page has more than just these three.
- "**not** uploaded to the bundle Volume" → "**not** included in the
  bundle (from above)" — reads more naturally given the prior section
  introduced the bundle.
- Step 3.1: name VOL_DIR as a candidate staging location for the init
  script itself (one less decision for the reader).

Render improvement:
- Replace the always-expanded CodeFromTest with a 10-line preview +
  native `<details>` disclosure containing the full script. Avoids
  burying the rest of the page under the init script when readers are
  scrolling through the install flow; opt-in to expand for full review.

Co-authored-by: Isaac
@mjohns-databricks mjohns-databricks requested a review from a team as a code owner May 20, 2026 22:39
@mjohns-databricks mjohns-databricks merged commit a413b75 into main May 20, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant